PrizmDoc
Enabling Content Encryption

This topic contains the following information:

The goal of content encryption is to provide an obscured transfer of data from the PrizmDoc Server to the Viewing Client website, preventing unauthorized agents to discern the content being transmitted. Additional security can be enabled by configuring the Viewing Client and server to communicate over the Secured Socket Layer (SSL), https protocol, rather than standard non-secure http protocol. In cases where this is not viable or enough protection, the content encryption adds a strong measure of privacy to the document content. When content encryption is enabled, the web data images and document text strings sent to the Viewing Client will be encrypted and then decrypted by the Viewing Client.

This feature is not supported in IE8.

Overview of Enabling Content Encryption

Content encryption must be enabled in the Viewing Client and in the PrizmDoc Server; it is disabled by default. Enabling content encryption in the Viewing Client is straightforward and performed by an option passed to the Viewing Client constructor or jQuery plugin. This process is documented below.

There are two options for enabling content encryption on the server:

  1. Enable content encryption via the ServiceHost pcc.config file: this enables content encryption for all viewing sessions.
  2. Toggle (enable or disable) content encryption via viewing session property: this enables or disables content encryption per viewing session, overriding the option set in the ServiceHost pcc.config file.

These options are both documented below.

For the security conscious, toggling content encryption per viewing session is not permitted in the out of box product configuration. It must be explicitly allowed via the ServiceHost pcc.config file.

Finally, it’s important to note it must be enabled or disabled on both the Viewing Client and server, or unexpected behavior will occur. If encryption is enabled on the server but not for the Viewing Client, then the content will not be rendered correctly. If encryption is enabled for the Viewing Client but not on the server, then the content will not be encrypted during transit, however, it will be rendered correctly in the Viewing Client.

In summary:

Enabling Content Encryption in PrizmDoc Server via ServiceHost pcc.config

To enable Content Encryption follow the steps below:

  1. Open the configuration file, pcc.config, for the Main Conversion Service in your favorite editor. The pcc.config file is located at: {installation directory}/Prizm/PCCIS/ServiceHost folder.
  2. Find the EncryptPageContent tag and change the value to true.
Encrypted Transmission:
Copy Code
<!--
  Indicates whether to encrypt pages which are sent to the client.
-->
<EncryptPageContent>true</EncryptPageContent>
  1. Save the changes to the file. 
  2. Restart the PrizmDoc Server for the changes to take effect.
  3. Continue by enabling the encryption option for the Viewing Client as described in the section below.

Enabling Content Encryption in PrizmDoc Server via ViewingSession Property

  1. Open the configuration file, pcc.config, for the Main Conversion Service in your favorite editor. The pcc.config file is located at: {installation directory}/Prizm/PCCIS/ServiceHost folder.
  2. Find the ViewingSessionPropertyPageContentEncryption tag and change the value to any.
Encrypted Transmission
Copy Code
< ViewingSessionPropertyPageContentEncryption>any</ ViewingSessionPropertyPageContentEncryption>
  1. Save the changes to the file.
  2. Restart the PrizmDoc Server for the changes to take effect.
  3. Update your web-tier code to set the value of pageContentEncryption to "enabled" when creating the viewing session. The example below is for a .NET web tier:
Example
Copy Code
viewingSessionProperties.pageContentEncryption = "enabled";
....
// Serialize document properties as JSON which will go into the body of the request
string requestBody = serializer.Serialize(viewingSessionProperties);
requestStream.Write(requestBody);
  1. Continue by enabling the encryption option for the Viewing Client as described in the section below.

Enabling Content Encryption in the Viewing Client

To enable encryption in the Viewing Client, provide encryption option in the viewerControlOptions parameter as follows so that the Viewing Client can handle encrypted data:

Example
Copy Code
var viewerControlOptions = {documentIdentifier: ‘xxxx... ‘
               imageHandler:’pcc.ashx’,
               . . .
               encryption : true
             };            
$("#mydiv").pccViewer(viewerControlOptions); // returns PCCViewer.ResponsiveViewer instance with encryption enabled.
Enabling the encryption will not work without setting the configuration parameter as described above. Also, if the PrizmDoc Server configuration setting is either not set or the PrizmDoc Server is not restarted, the data will arrive unencrypted.

How to Start & Stop the PrizmDoc Server

Refer to these topics for additional information:

Disabling Content Encryption in the PrizmDoc Server

To disable Content Encryption in the PrizmDoc Server, follow the steps below:

  1. Open the configuration file, pcc.config, for the Main Conversion Service in your favorite editor. The pcc.config file is located at: {installation directory}/Prizm/PCCIS/ServiceHost folder. 
  2. Find the EncryptPageContent tag and change the value to true.
Unencrypted Transmission:
Copy Code
<!--
  Indicates whether to encrypt pages which are sent to the client.
-->
<EncryptPageContent>false</EncryptPageContent>
  1. Save the changes to the file. 
  2. Restart the PrizmDoc Server for the changes to take effect.

Disabling Content Encryption in the Viewing Client

To disable encryption in the Viewing Client, use the Viewing Client's default behavior without providing the encryption option. By default, the Viewing Client sets the encryption value to 'false'. Should you wish to use the encryption in the viewerControlOptions parameter, set the encryption option to false as shown below:

Example
Copy Code
var viewerControlOptions = {documentIdentifier: ‘xxxx... ‘
               imageHandler:’pcc.ashx’,
               . . .
               encryption : false
             };  
Enabling/disabling the encryption will not work without appropriately setting the PrizmDoc Server configuration.

 

 

 


©2016. Accusoft Corporation. All Rights Reserved.

Send Feedback